Krocení bestie: Strategie pro refaktoring zastaralého kódu

Zastaralý kód. Samotný tento termín často vyvolává představy o rozsáhlých, nezdokumentovaných systémech, křehkých závislostech a drtivém pocitu hrůzy. Mnoho vývojářů po celém světě čelí výzvě udržovat a rozvíjet tyto systémy, které jsou často klíčové pro obchodní operace. Tento komplexní průvodce poskytuje praktické strategie pro refaktoring zastaralého kódu a mění zdroj frustrace v příležitost pro modernizaci a zlepšení.

Co je to zastaralý kód?

Než se ponoříme do technik refaktoringu, je nezbytné definovat, co „zastaralým kódem“ myslíme. Ačkoli se tento termín může jednoduše vztahovat na starší kód, jemnější definice se zaměřuje na jeho udržovatelnost. Michael Feathers ve své klíčové knize „Working Effectively with Legacy Code“ definuje zastaralý kód jako kód bez testů. Tento nedostatek testů ztěžuje bezpečnou úpravu kódu bez zavádění regresí. Zastaralý kód však může vykazovat i další vlastnosti:

• Nedostatek dokumentace: Původní vývojáři mohli odejít a zanechat za sebou malou nebo žádnou dokumentaci vysvětlující architekturu systému, rozhodnutí o návrhu nebo dokonce základní funkcionalitu.
• Složité závislosti: Kód může být těsně provázaný, což ztěžuje izolaci a úpravu jednotlivých komponent bez ovlivnění ostatních částí systému.
• Zastaralé technologie: Kód může být napsán ve starších programovacích jazycích, frameworcích nebo knihovnách, které již nejsou aktivně podporovány, což představuje bezpečnostní rizika a omezuje přístup k moderním nástrojům.
• Nízká kvalita kódu: Kód může obsahovat duplicitní kód, dlouhé metody a další „pachy v kódu“, které ztěžují jeho pochopení a údržbu.
• Křehký design: Zdánlivě malé změny mohou mít nepředvídatelné a rozsáhlé následky.

Je důležité si uvědomit, že zastaralý kód není ze své podstaty špatný. Často představuje významnou investici a ztělesňuje cenné doménové znalosti. Cílem refaktoringu je zachovat tuto hodnotu a zároveň zlepšit udržovatelnost, spolehlivost a výkon kódu.

Proč refaktorovat zastaralý kód?

Refaktoring zastaralého kódu může být náročný úkol, ale přínosy často převažují nad problémy. Zde jsou některé klíčové důvody, proč investovat do refaktoringu:

• Zlepšená udržovatelnost: Refaktoring usnadňuje pochopení, úpravu a ladění kódu, což snižuje náklady a úsilí potřebné pro průběžnou údržbu. Pro globální týmy je to obzvláště důležité, protože to snižuje závislost na konkrétních jednotlivcích a podporuje sdílení znalostí.
• Snížení technického dluhu: Technický dluh označuje implicitní náklady na přepracování způsobené volbou snadného řešení nyní namísto použití lepšího přístupu, který by trval déle. Refaktoring pomáhá tento dluh splácet a zlepšuje celkové zdraví kódové báze.
• Zvýšená spolehlivost: Řešením pachů v kódu a zlepšením jeho struktury může refaktoring snížit riziko chyb a zlepšit celkovou spolehlivost systému.
• Zvýšený výkon: Refaktoring může identifikovat a řešit výkonnostní úzká hrdla, což vede k rychlejšímu provádění a lepší odezvě.
• Snadnější integrace: Refaktoring může usnadnit integraci zastaralého systému s novými systémy a technologiemi, což umožňuje inovace a modernizaci. Například evropská e-commerce platforma může potřebovat integraci s novou platební bránou, která používá jiné API.
• Zlepšení morálky vývojářů: Práce s čistým, dobře strukturovaným kódem je pro vývojáře příjemnější a produktivnější. Refaktoring může zvýšit morálku a přilákat talenty.

Identifikace kandidátů na refaktoring

Ne každý zastaralý kód je třeba refaktorovat. Je důležité upřednostnit úsilí o refaktoring na základě následujících faktorů:

• Frekvence změn: Kód, který je často upravován, je hlavním kandidátem na refaktoring, protože zlepšení v udržovatelnosti bude mít významný dopad na produktivitu vývoje.
• Složitost: Kód, který je složitý a těžko srozumitelný, má větší pravděpodobnost, že bude obsahovat chyby, a je těžší ho bezpečně upravit.
• Dopad chyb: Kód, který je klíčový pro obchodní operace nebo u kterého existuje vysoké riziko vzniku nákladných chyb, by měl být pro refaktoring upřednostněn.
• Výkonnostní úzká hrdla: Kód, který je identifikován jako výkonnostní úzké hrdlo, by měl být refaktorován za účelem zlepšení výkonu.
• Pachy v kódu: Dávejte si pozor na běžné „pachy v kódu“, jako jsou dlouhé metody, velké třídy, duplicitní kód a závistivost vůči funkcím (feature envy). To jsou ukazatele oblastí, které by mohly z refaktoringu těžit.

Příklad: Představte si globální logistickou společnost se zastaralým systémem pro správu zásilek. Modul zodpovědný za výpočet přepravních nákladů je často aktualizován kvůli měnícím se předpisům a cenám paliva. Tento modul je hlavním kandidátem na refaktoring.

Techniky refaktoringu

K dispozici je mnoho technik refaktoringu, každá určená k řešení specifických pachů v kódu nebo ke zlepšení konkrétních aspektů kódu. Zde jsou některé běžně používané techniky:

Skládání metod

Tyto techniky se zaměřují na rozdělení velkých a složitých metod na menší, lépe zvládnutelné metody. To zlepšuje čitelnost, snižuje duplicitu a usnadňuje testování kódu.

• Extrahovat metodu: Zahrnuje identifikaci bloku kódu, který provádí specifický úkol, a jeho přesunutí do nové metody.
• Vložit metodu (inline): Zahrnuje nahrazení volání metody tělem metody. Použijte, když je název metody stejně jasný jako její tělo, nebo když se chystáte použít techniku Extrahovat metodu, ale stávající metoda je příliš krátká.
• Nahradit dočasnou proměnnou dotazem: Zahrnuje nahrazení dočasné proměnné voláním metody, která vypočítá hodnotu proměnné na vyžádání.
• Zavést vysvětlující proměnnou: Použijte k přiřazení výsledku výrazu proměnné s popisným názvem, čímž objasníte jeho účel.

Přesouvání funkčnosti mezi objekty

Tyto techniky se zaměřují na zlepšení návrhu tříd a objektů přesunem odpovědností tam, kam patří.

• Přesunout metodu: Zahrnuje přesunutí metody z jedné třídy do jiné třídy, kam logicky patří.
• Přesunout pole: Zahrnuje přesunutí pole z jedné třídy do jiné třídy, kam logicky patří.
• Extrahovat třídu: Zahrnuje vytvoření nové třídy ze soudržné sady odpovědností extrahovaných z existující třídy.
• Vložit třídu (inline): Použijte ke sbalení třídy do jiné, když už nedělá dost na to, aby ospravedlnila svou existenci.
• Skrýt delegáta: Zahrnuje vytvoření metod v serveru k ukrytí logiky delegování před klientem, čímž se snižuje provázanost mezi klientem a delegátem.
• Odstranit prostředníka: Pokud třída deleguje téměř veškerou svou práci, pomůže to odstranit prostředníka.
• Zavést cizí metodu: Přidá metodu do klientské třídy, aby obsloužila klienta funkcemi, které jsou skutečně potřeba ze serverové třídy, ale nelze je upravit kvůli nedostatku přístupu nebo plánovaným změnám v serverové třídě.
• Zavést lokální rozšíření: Vytvoří novou třídu, která obsahuje nové metody. Užitečné, když nekontrolujete zdroj třídy a nemůžete přidat chování přímo.

Organizace dat

Tyto techniky se zaměřují na zlepšení způsobu ukládání a přístupu k datům, což usnadňuje jejich pochopení a úpravu.

• Nahradit datovou hodnotu objektem: Zahrnuje nahrazení jednoduché datové hodnoty objektem, který zapouzdřuje související data a chování.
• Změnit hodnotu na referenci: Zahrnuje změnu hodnotového objektu na referenční objekt, když více objektů sdílí stejnou hodnotu.
• Změnit jednosměrnou asociaci na obousměrnou: Vytvoří obousměrný odkaz mezi dvěma třídami, kde existuje pouze jednosměrný odkaz.
• Změnit obousměrnou asociaci na jednosměrnou: Zjednodušuje asociace tím, že obousměrný vztah učiní jednosměrným.
• Nahradit magické číslo symbolickou konstantou: Zahrnuje nahrazení doslovných hodnot pojmenovanými konstantami, což usnadňuje pochopení a údržbu kódu.
• Zapouzdřit pole: Poskytuje metodu getter a setter pro přístup k poli.
• Zapouzdřit kolekci: Zajišťuje, že všechny změny v kolekci probíhají prostřednictvím pečlivě kontrolovaných metod ve vlastnické třídě.
• Nahradit záznam datovou třídou: Vytvoří novou třídu s poli odpovídajícími struktuře záznamu a přístupovými metodami.
• Nahradit kód typu třídou: Vytvořte novou třídu, když kód typu má omezenou, známou sadu možných hodnot.
• Nahradit kód typu podtřídami: Pro případy, kdy hodnota kódu typu ovlivňuje chování třídy.
• Nahradit kód typu stavem/strategií: Pro případy, kdy hodnota kódu typu ovlivňuje chování třídy, ale použití podtříd není vhodné.
• Nahradit podtřídu poli: Odstraní podtřídu a přidá do nadtřídy pole představující odlišné vlastnosti podtřídy.

Zjednodušení podmíněných výrazů

Podmíněná logika se může rychle stát spletitou. Tyto techniky se snaží ji objasnit a zjednodušit.

• Rozložit podmínku: Zahrnuje rozdělení složitého podmíněného příkazu na menší, lépe zvládnutelné části.
• Sloučit podmíněný výraz: Zahrnuje sloučení více podmíněných příkazů do jednoho, stručnějšího příkazu.
• Sloučit duplicitní fragmenty v podmínkách: Zahrnuje přesunutí kódu, který je duplikován ve více větvích podmíněného příkazu, mimo tuto podmínku.
• Odstranit řídicí příznak: Eliminujte booleovské proměnné používané k řízení toku logiky.
• Nahradit vnořenou podmínku ochrannými klauzulemi (guard clauses): Zlepšuje čitelnost kódu umístěním všech speciálních případů na začátek a zastavením zpracování, pokud je některý z nich pravdivý.
• Nahradit podmínku polymorfismem: Zahrnuje nahrazení podmíněné logiky polymorfismem, což umožňuje různým objektům zpracovávat různé případy.
• Zavést nulový objekt (Null Object): Místo kontroly na hodnotu null vytvořte výchozí objekt, který poskytuje výchozí chování.
• Zavést tvrzení (assertion): Explicitně dokumentujte očekávání vytvořením testu, který je kontroluje.

Zjednodušení volání metod

• Přejmenovat metodu: Zdá se to zřejmé, ale je to neuvěřitelně užitečné pro zpřehlednění kódu.
• Přidat parametr: Přidání informací do signatury metody umožňuje, aby byla metoda flexibilnější a znovupoužitelná.
• Odstranit parametr: Pokud se parametr nepoužívá, zbavte se ho, abyste zjednodušili rozhraní.
• Oddělit dotaz od modifikátoru: Pokud metoda zároveň mění hodnotu a vrací ji, rozdělte ji na dvě odlišné metody.
• Parametrizovat metodu: Použijte k sloučení podobných metod do jedné metody s parametrem, který mění chování.
• Nahradit parametr explicitními metodami: Udělejte opak parametrizace – rozdělte jednu metodu na více metod, z nichž každá představuje specifickou hodnotu parametru.
• Zachovat celý objekt: Místo předávání několika konkrétních datových položek metodě předejte celý objekt, aby metoda měla přístup ke všem jeho datům.
• Nahradit parametr metodou: Pokud je metoda vždy volána se stejnou hodnotou odvozenou z pole, zvažte odvození hodnoty parametru uvnitř metody.
• Zavést objekt parametrů: Seskupte několik parametrů do objektu, když k sobě přirozeně patří.
• Odstranit nastavovací metodu (setter): Vyhněte se setterům, pokud by pole mělo být pouze inicializováno, ale po konstrukci již neupravováno.
• Skrýt metodu: Snižte viditelnost metody, pokud se používá pouze v rámci jedné třídy.
• Nahradit konstruktor tovární metodou (factory method): Popisnější alternativa ke konstruktorům.
• Nahradit výjimku testem: Pokud jsou výjimky používány jako řízení toku, nahraďte je podmíněnou logikou pro zlepšení výkonu.

Práce s generalizací

• Vytáhnout pole nahoru: Přesuňte pole z podtřídy do její nadtřídy.
• Vytáhnout metodu nahoru: Přesuňte metodu z podtřídy do její nadtřídy.
• Vytáhnout tělo konstruktoru nahoru: Přesuňte tělo konstruktoru z podtřídy do její nadtřídy.
• Stlačit metodu dolů: Přesuňte metodu z nadtřídy do jejích podtříd.
• Stlačit pole dolů: Přesuňte pole z nadtřídy do jejích podtříd.
• Extrahovat rozhraní: Vytvoří rozhraní z veřejných metod třídy.
• Extrahovat nadtřídu: Přesuňte společnou funkcionalitu ze dvou tříd do nové nadtřídy.
• Sbalit hierarchii: Sloučte nadtřídu a podtřídu do jedné třídy.
• Vytvořit šablonovou metodu (template method): Vytvořte šablonovou metodu v nadtřídě, která definuje kroky algoritmu, a umožněte podtřídám přepsat specifické kroky.
• Nahradit dědičnost delegováním: Vytvořte v třídě pole odkazující na funkcionalitu, místo aby ji dědila.
• Nahradit delegování dědičností: Když je delegování příliš složité, přejděte na dědičnost.

Toto je jen několik příkladů z mnoha dostupných technik refaktoringu. Volba techniky závisí na konkrétním pachu v kódu a požadovaném výsledku.

Příklad: Rozsáhlá metoda v Java aplikaci, kterou používá globální banka, vypočítává úrokové sazby. Použití techniky Extrahovat metodu k vytvoření menších, více zaměřených metod zlepšuje čitelnost a usnadňuje aktualizaci logiky výpočtu úrokových sazeb bez ovlivnění ostatních částí metody.

Proces refaktoringu

K refaktoringu je třeba přistupovat systematicky, aby se minimalizovalo riziko a maximalizovaly šance na úspěch. Zde je doporučený postup:

1. Identifikujte kandidáty na refaktoring: Použijte výše zmíněná kritéria k identifikaci oblastí kódu, které by z refaktoringu měly největší prospěch.
2. Vytvořte testy: Před provedením jakýchkoli změn napište automatizované testy k ověření stávajícího chování kódu. To je klíčové pro zajištění, že refaktoring nezavede regrese. Nástroje jako JUnit (Java), pytest (Python) nebo Jest (JavaScript) lze použít pro psaní jednotkových testů.
3. Refaktorujte inkrementálně: Provádějte malé, inkrementální změny a po každé změně spouštějte testy. To usnadňuje identifikaci a opravu jakýchkoli chyb, které jsou zavedeny.
4. Commitujte často: Často odesílejte své změny do systému pro správu verzí. To vám umožní snadno se vrátit k předchozí verzi, pokud se něco pokazí.
5. Revize kódu (code review): Nechte si kód zkontrolovat jiným vývojářem. To může pomoci identifikovat potenciální problémy a zajistit, že refaktoring je proveden správně.
6. Sledujte výkon: Po refaktoringu sledujte výkon systému, abyste se ujistili, že změny nezavedly žádné výkonnostní regrese.

Příklad: Tým refaktorující Python modul na globální e-commerce platformě používá `pytest` k vytvoření jednotkových testů pro stávající funkcionalitu. Poté aplikují refaktoring Extrahovat třídu, aby oddělili zodpovědnosti a zlepšili strukturu modulu. Po každé malé změně spouštějí testy, aby se ujistili, že funkcionalita zůstala nezměněna.

Strategie pro zavedení testů do zastaralého kódu

Jak Michael Feathers trefně uvedl, zastaralý kód je kód bez testů. Zavádění testů do existujících kódových bází se může zdát jako obrovský úkol, ale je to nezbytné pro bezpečný refaktoring. Zde je několik strategií, jak k tomuto úkolu přistoupit:

Charakterizační testy (aka Golden Master Testy)

Když se potýkáte s kódem, který je těžko srozumitelný, charakterizační testy vám mohou pomoci zachytit jeho stávající chování, než začnete provádět změny. Myšlenka je napsat testy, které ověřují aktuální výstup kódu pro danou sadu vstupů. Tyto testy nutně neověřují správnost; jednoduše dokumentují, co kód *aktuálně* dělá.

Postup:

1. Identifikujte jednotku kódu, kterou chcete charakterizovat (např. funkci nebo metodu).
2. Vytvořte sadu vstupních hodnot, které představují řadu běžných i okrajových scénářů.
3. Spusťte kód s těmito vstupy a zachyťte výsledné výstupy.
4. Napište testy, které ověřují, že kód pro tyto vstupy produkuje přesně tyto výstupy.

Upozornění: Charakterizační testy mohou být křehké, pokud je podkladová logika složitá nebo závislá na datech. Buďte připraveni je aktualizovat, pokud budete potřebovat později změnit chování kódu.

Metody Sprout a Třídy Sprout (Sprout Method and Sprout Class)

Tyto techniky, které také popsal Michael Feathers, mají za cíl zavést novou funkcionalitu do zastaralého systému a zároveň minimalizovat riziko narušení stávajícího kódu.

Metoda Sprout (Sprout Method): Když potřebujete přidat novou funkci, která vyžaduje úpravu stávající metody, vytvořte novou metodu obsahující novou logiku. Poté tuto novou metodu zavolejte ze stávající metody. To vám umožní izolovat nový kód a testovat jej nezávisle.

Třída Sprout (Sprout Class): Podobně jako metoda Sprout, ale pro třídy. Vytvořte novou třídu, která implementuje novou funkcionalitu, a poté ji integrujte do stávajícího systému.

Sandboxing

Sandboxing zahrnuje izolaci zastaralého kódu od zbytku systému, což vám umožní testovat ho v kontrolovaném prostředí. To lze provést vytvořením mocků nebo stubů pro závislosti nebo spuštěním kódu ve virtuálním stroji.

Metoda Mikado

Metoda Mikado je vizuální přístup k řešení problémů pro zvládání složitých úkolů refaktoringu. Zahrnuje vytvoření diagramu, který představuje závislosti mezi různými částmi kódu, a následný refaktoring kódu způsobem, který minimalizuje dopad na ostatní části systému. Základním principem je „vyzkoušet“ změnu a zjistit, co se rozbije. Pokud se to rozbije, vraťte se k poslednímu funkčnímu stavu a zaznamenejte problém. Poté tento problém vyřešte, než se znovu pokusíte o původní změnu.

Nástroje pro refaktoring

S refaktoringem může pomoci několik nástrojů, které automatizují opakující se úkoly a poskytují vodítka k osvědčeným postupům. Tyto nástroje jsou často integrovány do integrovaných vývojových prostředí (IDE):

• IDE (např. IntelliJ IDEA, Eclipse, Visual Studio): IDE poskytují vestavěné nástroje pro refaktoring, které mohou automaticky provádět úkoly jako přejmenování proměnných, extrakce metod a přesouvání tříd.
• Nástroje pro statickou analýzu (např. SonarQube, Checkstyle, PMD): Tyto nástroje analyzují kód na pachy v kódu, potenciální chyby a bezpečnostní zranitelnosti. Mohou pomoci identifikovat oblasti kódu, které by měly prospěch z refaktoringu.
• Nástroje pro pokrytí kódu (např. JaCoCo, Cobertura): Tyto nástroje měří procento kódu, které je pokryto testy. Mohou pomoci identifikovat oblasti kódu, které nejsou dostatečně testovány.
• Prohlížeče pro refaktoring (např. Smalltalk Refactoring Browser): Specializované nástroje, které pomáhají při větších restrukturalizačních činnostech.

Příklad: Vývojový tým pracující na C# aplikaci pro globální pojišťovnu používá vestavěné nástroje pro refaktoring ve Visual Studiu k automatickému přejmenování proměnných a extrakci metod. Používají také SonarQube k identifikaci pachů v kódu a potenciálních zranitelností.

Výzvy a rizika

Refaktoring zastaralého kódu není bez výzev a rizik:

• Zavádění regresí: Největším rizikem je zavedení chyb během procesu refaktoringu. To lze zmírnit psaním komplexních testů a inkrementálním refaktoringem.
• Nedostatek doménových znalostí: Pokud původní vývojáři odešli, může být obtížné porozumět kódu a jeho účelu. To může vést k nesprávným rozhodnutím o refaktoringu.
• Těsná provázanost (tight coupling): Těsně provázaný kód je obtížnější refaktorovat, protože změny v jedné části kódu mohou mít nezamýšlené důsledky na jiné části kódu.
• Časová omezení: Refaktoring může zabrat čas a může být obtížné ospravedlnit investici zúčastněným stranám, které se soustředí na dodávání nových funkcí.
• Odpor ke změnám: Někteří vývojáři mohou být odolní vůči refaktoringu, zejména pokud nejsou obeznámeni s příslušnými technikami.

Osvědčené postupy (Best Practices)

Chcete-li zmírnit výzvy a rizika spojená s refaktoringem zastaralého kódu, dodržujte tyto osvědčené postupy:

• Získejte souhlas (buy-in): Ujistěte se, že zúčastněné strany chápou přínosy refaktoringu a jsou ochotny investovat potřebný čas a zdroje.
• Začněte v malém: Začněte refaktoringem malých, izolovaných částí kódu. To pomůže vybudovat důvěru a ukázat hodnotu refaktoringu.
• Refaktorujte inkrementálně: Provádějte malé, inkrementální změny a často testujte. To usnadní identifikaci a opravu jakýchkoli zavedených chyb.
• Automatizujte testy: Napište komplexní automatizované testy k ověření chování kódu před a po refaktoringu.
• Používejte nástroje pro refaktoring: Využijte nástroje pro refaktoring dostupné ve vašem IDE nebo jiných nástrojích k automatizaci opakujících se úkolů a poskytování vodítek k osvědčeným postupům.
• Dokumentujte své změny: Dokumentujte změny, které provedete během refaktoringu. To pomůže ostatním vývojářům porozumět kódu a vyhnout se zavádění regresí v budoucnu.
• Kontinuální refaktoring: Učiňte refaktoring nepřetržitou součástí vývojového procesu, spíše než jednorázovou událostí. To pomůže udržet kódovou bázi čistou a udržovatelnou.

Závěr

Refaktoring zastaralého kódu je náročný, ale obohacující úkol. Dodržováním strategií a osvědčených postupů uvedených v tomto průvodci můžete zkrotit bestii a přeměnit vaše zastaralé systémy na udržovatelná, spolehlivá a výkonná aktiva. Nezapomeňte přistupovat k refaktoringu systematicky, často testovat a efektivně komunikovat se svým týmem. S pečlivým plánováním a provedením můžete odemknout skrytý potenciál ve vašem zastaralém kódu a připravit půdu pro budoucí inovace.